Version: 1.0.2

Get a List of Cards

Getting the list and details of all cards issued to the specified account number.

Method: POST

{{URL}}/cardv2

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameters	Description
reference Optional	String Unique reference ID of the request Sample Value: "visadps100009"
transactionType Mandatory	String Type of operation / transaction Constant Value: "GET_CARD_LIST"
customerId Mandatory	String Unique ID of customer who holds the card Sample Value: "100000000006001"
accountNumber Mandatory	String Account number linked to the card Sample Value: "400320588344662"
product Mandatory	String Name of the product associated with the card Sample Value: "DEFAULT"
channel Mandatory	Enum Processing channel through which the card transaction happens Valid Values: PULSE VISA_DPS Sample Value: "VISA_DPS"
program Mandatory	String Name of the program to which the card product is mapped Sample Value: "DEFAULT"
pagination Mandatory	Object
offset Mandatory	Number Starting point of fetching the list of cards Sample Value: 0
max Mandatory	Number Maximum number of records to retrieve in this request from the starting point (offset value) Sample Value: 5

Parameters

Description

reference

Optional

String

Unique reference ID of the request

Sample Value: "visadps100009"

transactionType

Mandatory

String

Type of operation / transaction

Constant Value: "GET_CARD_LIST"

customerId

Mandatory

String

Unique ID of customer who holds the card

Sample Value: "100000000006001"

accountNumber

Mandatory

String

Account number linked to the card

Sample Value: "400320588344662"

product

Mandatory

String

Name of the product associated with the card

Sample Value: "DEFAULT"

channel

Mandatory

Enum

Processing channel through which the card transaction happens

Valid Values:

PULSE

VISA_DPS

Sample Value: "VISA_DPS"

program

Mandatory

String

Name of the program to which the card product is mapped

Sample Value: "DEFAULT"

pagination

Mandatory

Object

offset

Mandatory

Number

Starting point of fetching the list of cards

Sample Value: 0

max

Mandatory

Number

Maximum number of records to retrieve in this request from the starting point (offset value)

Sample Value: 5

cURL
C#
Go
NodeJs

curl --location --globoff --request GET '{{URL}}/cardv2' \
--header 'Content-Type: application/json' \
--data '{"method":"ledger.CARD.request","id":"1","params":{"payload":{"reference":"visadps100009","transactionType":"GET_CARD_LIST","customerId":"100000000006001","accountNumber":"400320588344662","product":"DEFAULT","channel":"VISA_DPS","program":"DEFAULT","pagination":{"offset":0,"max":5}},"api":{"credential":"{{cred}}","signature":"{{signature}}","apiKey":"{{Api-key}}"}}}'

using System;
using RestSharp;
using System.Threading;
using System.Threading.Tasks;
namespace HelloWorldApplication {
  class HelloWorld {
    static async Task Main(string[] args) {
      var options = new RestClientOptions("{{URL}}/cardv2")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""ledger.CARD.request"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""reference"": ""visadps100009"",
" + "\n" +
@"            ""transactionType"": ""GET_CARD_LIST"",
" + "\n" +
@"            ""customerId"": ""100000000006001"",
" + "\n" +
@"            ""accountNumber"": ""400320588344662"",
" + "\n" +
@"            ""product"": ""DEFAULT"",
" + "\n" +
@"            ""channel"": ""VISA_DPS"",
" + "\n" +
@"            ""program"": ""DEFAULT"",
" + "\n" +
@"            ""pagination"": {
" + "\n" +
@"                ""offset"": 0,
" + "\n" +
@"                ""max"": 5
" + "\n" +
@"            }
" + "\n" +
@"        },
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""credential"": ""{{cred}}"",
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""apiKey"": ""{{Api-key}}""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
    }
  }
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{URL}}/cardv2"
  method := "GET"

  payload := strings.NewReader(`{`+"
"+`
    "method": "ledger.CARD.request",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "payload": {`+"
"+`
            "reference": "visadps100009",`+"
"+`
            "transactionType": "GET_CARD_LIST",`+"
"+`
            "customerId": "100000000006001",`+"
"+`
            "accountNumber": "400320588344662",`+"
"+`
            "product": "DEFAULT",`+"
"+`
            "channel": "VISA_DPS",`+"
"+`
            "program": "DEFAULT",`+"
"+`
            "pagination": {`+"
"+`
                "offset": 0,`+"
"+`
                "max": 5`+"
"+`
            }`+"
"+`
        },`+"
"+`
        "api": {`+"
"+`
            "credential": "{{cred}}",`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "apiKey": "{{Api-key}}"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': '{{URL}}',
  'path': '/cardv2',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ledger.CARD.request",
  "id": "1",
  "params": {
    "payload": {
      "reference": "visadps100009",
      "transactionType": "GET_CARD_LIST",
      "customerId": "100000000006001",
      "accountNumber": "400320588344662",
      "product": "DEFAULT",
      "channel": "VISA_DPS",
      "program": "DEFAULT",
      "pagination": {
        "offset": 0,
        "max": 5
      }
    },
    "api": {
      "credential": "{{cred}}",
      "signature": "{{signature}}",
      "apiKey": "{{Api-key}}"
    }
  }
});

req.write(postData);

req.end();

Body

{
    "method": "ledger.CARD.request",
    "id": "1",
    "params": {
        "payload": {
            "reference": "visadps100009",
            "transactionType": "GET_CARD_LIST",
            "customerId": "100000000006001",
            "accountNumber": "400320588344662",
            "product": "DEFAULT",
            "channel": "VISA_DPS",
            "program": "DEFAULT",
            "pagination": {
                "offset": 0,
                "max": 5
            }
        },
        "api": {
            "credential": "{{cred}}",
            "signature": "{{signature}}",
            "apiKey": "{{Api-key}}"
        }
    }
}

Response: 200

Response Parameters

Parameters	Description
Id	String Response ID echoed from the request ID Sample Value: "1"
result	Object
cards	Array
cardId	String Unique ID of the card Sample Value: "025951734ff74c13a14137e02834fa00"
cardHolderName	String Name of the card holder Sample Value: "Matthew Sandra"
cardProduct	String ID of the card product associated to the card Sample Value: "2c6b841a-dfc1-4a6a-a12a-13c21035b5be"
cardType	Enum Card type is whether physical or virtual Valid Values: PHYSICAL VIRTUAL Sample Value: "VIRTUAL"
postedDate	String Date and time when the card details were posted Sample Value: "2024-11-20T06:56:11.399Z"
updatedDate	String Date and time when the card details were updated Sample Value: "2024-11-20T06:56:11.399Z"
cardMaskNumber	String Masked representation of the card number Sample Value: "************8886"
cardStatus	String Current status of card Sample Value: "ACTIVATED"
lockCardAcceptor	Enum Whether card is restricted to specific card acceptor or not, which is depending upon the given value Valid Values: DEFAULT – takes the value (YES or NO) given by admin YES – card is restricted to specific card acceptor NO – card is not restricted to specific card acceptor Sample Value: "DEFAULT "
cardExpiryDate	String Expiration date of the card in YYYYMM format Sample Value: "202501"
allowAtm	Boolean Allowing card for transactions through ATM Sample Value: false
allowEcommerce	Boolean Allowing card for e-commerce transactions Sample Value: false
allowMoto	Boolean Allowing card for transactions through mobile Sample Value: false
allowPos	Boolean Allowing card for point-of-sale (POS) terminal transaction Sample Value: false
allowTips	Boolean Allowing card for tips transaction Sample Value: false
allowPurchase	Boolean Allowing card for purchase transaction Sample Value: false
allowRefund	Boolean Allowing card for refund transaction Sample Value: false
allowCashback	Boolean Allowing card for cashback transaction Sample Value: false
allowWithdraw	Boolean Allowing card for ATM withdrawal transaction Sample Value: false
allowAuthAndCompletion	Boolean Allowing for authorization and completion of transaction that happens through card Sample Value: false
smart	Boolean Allowing card for smart transaction Sample Value: false
checkAvsZip	Boolean Allowing card to perform AVS checks on the legalRep ZIP code during transaction Sample Value: false
checkAvsAddr	Boolean Allowing card to perform AVS checks on the legalRep address during transaction Sample Value: false
cvv	String Card Verification Value of the card Sample Value: ""
singleUseCard	Enum Whether card is for single use or multiple use Valid Values: Yes - SingleUseCard – Card is used for single transaction within configured card limit No – MultiUse Card - Card can be used for multiple transactions within configured card limit daily/monthly/yearly/lifetime Sample Value: "NO "
cardName	String Name given to the card Sample Value: "TEST CARD "
transactionMade	Boolean Inicates whether any transactions have been made using the card or not Sample Value: false
network	String Processing network through which the card transaction happens Sample Value: "VISA_DPS"
isReIssue	Boolean Inicates whether the card is reissued Sample Value: false
isReplace	Boolean Inicates whether the card replaced Sample Value: false
totalRecords	Number Total number of records retrieved in the response for the request Sample Value: 8
api	Object
type	String Acknowledgement for type of operation requested for Sample Value: "GET_CARD_LIST_ACK"
reference	String Unique reference for the API response Sample Value: "REFvisadps100009"
dateCreated	Number Unix timestamp of the response was created Sample Value: 1732086118
originalReference	String Original reference ID taken from the request Sample Value: "visadps100009"

{
   "id": "1",
   "result": {
       "cards": [
           {
               "cardId": "025951734ff74c13a14137e02834fa00",
               "cardHolderName": "Matthew Sandra",
               "cardProduct": "2c6b841a-dfc1-4a6a-a12a-13c21035b5be",
               "cardType": "VIRTUAL",
               "postedDate": "2024-11-20T06:56:11.399Z",
               "updatedDate": "2024-11-20T06:56:11.399Z",
               "cardMaskNumber": "************8886",
               "cardStatus": "ACTIVATED",
               "lockCardacceptor": "DEFAULT",
               "cardExpiryDate": "202501",
               "allowAtm": false,
               "allowEcommerce": false,
               "allowMoto": false,
               "allowPos": false,
               "allowTips": false,
               "allowPurchase": false,
               "allowRefund": false,
               "allowCashback": false,
               "allowWithdraw": false,
               "allowAuthAndCompletion": false,
               "smart": false,
               "checkAvsZip": false,
               "checkAvsAddr": false,
               "cvv": "",
               "singleUseCard": "NO",
               "cardName": "TEST CARD",
               "transactionMade": false,
               "network": "VISA_DPS",
               "isReIssue": false,
               "isReplace": false
           },
           {
               "cardId": "6f586be7bf1c44b8b4ea11b2e2510e25",
               "cardHolderName": "Matthew Sandra",
               "cardProduct": "2c6b841a-dfc1-4a6a-a12a-13c21035b5be",
               "cardType": "PHYSICAL",
               "postedDate": "2024-11-20T06:54:26.822Z",
               "updatedDate": "2024-11-20T06:59:13.805Z",
               "cardMaskNumber": "************5461",
               "cardStatus": "ACTIVATED",
               "cardExpiryDate": "202611",
               "allowAtm": false,
               "allowEcommerce": false,
               "allowMoto": false,
               "allowPos": false,
               "allowTips": false,
               "allowPurchase": false,
               "allowRefund": false,
               "allowCashback": false,
               "allowWithdraw": false,
               "allowAuthAndCompletion": false,
               "smart": false,
               "checkAvsZip": false,
               "checkAvsAddr": false,
               "cvv": "",
               "cardName": "Matthew Sandra",
               "transactionMade": false,
               "network": "VISA_DPS",
               "isReIssue": false,
               "isReplace": false
           },
           {
               "cardId": "050f8022e3b74b068df73ab5b5349bd5",
               "cardHolderName": "John Deo",
               "cardProduct": "2c6b841a-dfc1-4a6a-a12a-13c21035b5be",
               "cardType": "VIRTUAL",
               "postedDate": "2024-11-14T07:16:53.415Z",
               "updatedDate": "2024-11-14T07:16:53.415Z",
               "cardMaskNumber": "************4637",
               "cardStatus": "ACTIVATED",
               "lockCardacceptor": "DEFAULT",
               "cardExpiryDate": "202501",
               "allowAtm": false,
               "allowEcommerce": false,
               "allowMoto": false,
               "allowPos": false,
               "allowTips": false,
               "allowPurchase": false,
               "allowRefund": false,
               "allowCashback": false,
               "allowWithdraw": false,
               "allowAuthAndCompletion": false,
               "smart": false,
               "checkAvsZip": false,
               "checkAvsAddr": false,
               "cvv": "",
               "singleUseCard": "NO",
               "cardName": "TEST CARD",
               "transactionMade": false,
               "network": "VISA_DPS",
               "isReIssue": false,
               "isReplace": false
           },
           {
               "cardId": "fba07da39ac24ebca109d02a6ec9caae",
               "cardHolderName": "John Deo",
               "cardProduct": "2c6b841a-dfc1-4a6a-a12a-13c21035b5be",
               "cardType": "VIRTUAL",
               "postedDate": "2024-11-14T07:16:34.165Z",
               "updatedDate": "2024-11-14T07:16:34.165Z",
               "cardMaskNumber": "************2593",
               "cardStatus": "ACTIVATED",
               "lockCardacceptor": "DEFAULT",
               "cardExpiryDate": "202501",
               "allowAtm": false,
               "allowEcommerce": false,
               "allowMoto": false,
               "allowPos": false,
               "allowTips": false,
               "allowPurchase": false,
               "allowRefund": false,
               "allowCashback": false,
               "allowWithdraw": false,
               "allowAuthAndCompletion": false,
               "smart": false,
               "checkAvsZip": false,
               "checkAvsAddr": false,
               "cvv": "",
               "singleUseCard": "YES",
               "cardLimit": "100",
               "cardName": "TEST CARD",
               "transactionMade": false,
               "network": "VISA_DPS",
               "isReIssue": false,
               "isReplace": false
           },
           {
               "cardId": "cf6406dde90b41caa35d702d6fa55d94",
               "cardHolderName": "John Deo",
               "cardProduct": "2c6b841a-dfc1-4a6a-a12a-13c21035b5be",
               "cardType": "PHYSICAL",
               "postedDate": "2024-11-14T07:06:46.029Z",
               "updatedDate": "2024-11-14T07:18:53.886Z",
               "cardMaskNumber": "************6946",
               "cardStatus": "ACTIVATED",
               "cardExpiryDate": "202611",
               "allowAtm": false,
               "allowEcommerce": false,
               "allowMoto": false,
               "allowPos": false,
               "allowTips": false,
               "allowPurchase": false,
               "allowRefund": false,
               "allowCashback": false,
               "allowWithdraw": false,
               "allowAuthAndCompletion": false,
               "smart": false,
               "checkAvsZip": false,
               "checkAvsAddr": false,
               "cvv": "",
               "cardName": "John Deo",
               "transactionMade": false,
               "network": "VISA_DPS",
               "isReIssue": false,
               "isReplace": false
           }
       ],
       "totalRecords": 8,
       "api": {
           "type": "GET_CARD_LIST_ACK",
           "reference": "REFvisadps100009",
           "dateCreated": 1732086118,
           "originalReference": "visadps100009"
       }
   }
}

Get a List of Cards

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200